\nA service to interact with the list of users and groups of the platform.\n
", "extensionPoints": [ { "@type": "NXExtensionPoint", "componentId": "org.nuxeo.ecm.platform.usermanager.UserService", "descriptors": [ "org.nuxeo.ecm.platform.usermanager.UserManagerDescriptor" ], "documentation": "\n Configure the userManager.\n \n\n The extension should use the format:\n\n \n \n somedirectory \n mail \n \n first \n last \n \n tabbed \n \n Anonymous \n User \n \n \n secret \n My Custom \n Administrator \n administrators \n \n \n secret \n My Custom \n Member \n members \n othergroup \n \n item1 \n item2 \n \n \n \n \n admin \n myAdministrators \n \n false\n \n sn \n ^[a-zA-Z0-9]{5,}$ \n \n somegroupdir \n members \n grouplabel \n subgroups \n parentgroup \n search_only \n \n grouplabel \n groupname \n \n \n members \n groupname \n \n\n\n\n If the element anonymousUser has the attribute remove=\"true\", then the\n anonymous user will be disabled. The anonymous user is searchable by\n default.\n \n\n If a virtual user has the attribute remove=\"true\", it is removed from the\n list of virtual users. Virtual users are searchable by default, but it is\n not implemented yet... so you should keep the attribute searchable=\"false\"\n to keep the same behaviour when it will be.\n \n\n Virtual users with the \"administrators\" group will have the same rights\n than the default administrator.\n \n\n New administrators groups can be added using the \"administratorsGroup\"\n tag. Several groups can be defined, adding as many tags as needed. The\n default group named \"administrators\" can be disabled by setting the\n \"disableDefaultAdministratorsGroup\" to \"true\" (defaults to false): only\n new defined administrators groups will then be taken into account. Note\n that disabling this default group should be done after setting up custom\n rights in the repository, as this group is usually defined as the group of\n users who have all permissions at the root of the repository.\n \n\n Anonymous and virtual users properties have to match the users directory\n schema fields to be taken into account.\n \n\n The userPasswordPattern format is specified by java.util.regex.Pattern.\n \n\n The values for users listingMode are: \"all\", \"tabbed\", \"search_only\".\n (These values are defined in\n org.nuxeo.ecm.webapp.security.UserManagerActionsBean.)\n \n\n The values for groups listingMode are: \"all\" and \"search_only\".\n \n",
"documentationHtml": "\nConfigure the userManager.\n
\nThe extension should use the format:\n
<userManager>\n <users>\n <directory>somedirectory</directory>\n <emailField>mail</emailField>\n <searchFields append="true">\n <substringMatchSearchField>first</substringMatchSearchField>\n <exactMatchSearchField>last</exactMatchSearchField>\n </searchFields>\n <listingMode>tabbed</listingMode>\n <anonymousUser id="Anonymous">\n <property name="firstName">Anonymous</property>\n <property name="lastName">User</property>\n </anonymousUser>\n <virtualUser id="MyCustomAdministrator" searchable="false">\n <password>secret</password>\n <property name="firstName">My Custom</property>\n <property name="lastName">Administrator</property>\n <group>administrators</group>\n </virtualUser>\n <virtualUser id="MyCustomMember" searchable="false">\n <password>secret</password>\n <property name="firstName">My Custom</property>\n <property name="lastName">Member</property>\n <group>members</group>\n <group>othergroup</group>\n <propertyList name="listprop">\n <value>item1</value>\n <value>item2</value>\n </propertyList>\n </virtualUser>\n <virtualUser id="ExistingVirtualUser" remove="true"/>\n </users>\n <defaultAdministratorId>admin</defaultAdministratorId>\n <administratorsGroup>myAdministrators</administratorsGroup>\n <disableDefaultAdministratorsGroup>\n false\n </disableDefaultAdministratorsGroup>\n <userSortField>sn</userSortField>\n <userPasswordPattern>^[a-zA-Z0-9]{5,}$</userPasswordPattern>\n <groups>\n <directory>somegroupdir</directory>\n <membersField>members</membersField>\n <groupLabelField>grouplabel</groupLabelField>\n <subGroupsField>subgroups</subGroupsField>\n <parentGroupsField>parentgroup</parentGroupsField>\n <listingMode>search_only</listingMode>\n <searchFields append="true">\n <substringMatchSearchField>grouplabel</substringMatchSearchField>\n <exactMatchSearchField>groupname</exactMatchSearchField>\n </searchFields>\n </groups>\n <defaultGroup>members</defaultGroup>\n <groupSortField>groupname</groupSortField>\n </userManager>\n\nIf the element anonymousUser has the attribute remove="true", then the\nanonymous user will be disabled. The anonymous user is searchable by\ndefault.\n
\nIf a virtual user has the attribute remove="true", it is removed from the\nlist of virtual users. Virtual users are searchable by default, but it is\nnot implemented yet... so you should keep the attribute searchable="false"\nto keep the same behaviour when it will be.\n
\nVirtual users with the "administrators" group will have the same rights\nthan the default administrator.\n
\nNew administrators groups can be added using the "administratorsGroup"\ntag. Several groups can be defined, adding as many tags as needed. The\ndefault group named "administrators" can be disabled by setting the\n"disableDefaultAdministratorsGroup" to "true" (defaults to false): only\nnew defined administrators groups will then be taken into account. Note\nthat disabling this default group should be done after setting up custom\nrights in the repository, as this group is usually defined as the group of\nusers who have all permissions at the root of the repository.\n
\nAnonymous and virtual users properties have to match the users directory\nschema fields to be taken into account.\n
\nThe userPasswordPattern format is specified by java.util.regex.Pattern.\n
\nThe values for users listingMode are: "all", "tabbed", "search_only".\n(These values are defined in\norg.nuxeo.ecm.webapp.security.UserManagerActionsBean.)\n
\nThe values for groups listingMode are: "all" and "search_only".\n
", "hierarchyPath": "/grp:org.nuxeo.ecm.platform/org.nuxeo.ecm.platform.usermanager/org.nuxeo.ecm.platform.usermanager.UserService/ExtensionPoints/org.nuxeo.ecm.platform.usermanager.UserService--userManager", "id": "org.nuxeo.ecm.platform.usermanager.UserService--userManager", "label": "userManager (org.nuxeo.ecm.platform.usermanager.UserService)", "name": "userManager", "version": "2021.53.3" } ], "extensions": [], "hierarchyPath": "/grp:org.nuxeo.ecm.platform/org.nuxeo.ecm.platform.usermanager/org.nuxeo.ecm.platform.usermanager.UserService", "name": "org.nuxeo.ecm.platform.usermanager.UserService", "requirements": [], "resolutionOrder": 566, "services": [ { "@type": "NXService", "componentId": "org.nuxeo.ecm.platform.usermanager.UserService", "hierarchyPath": "/grp:org.nuxeo.ecm.platform/org.nuxeo.ecm.platform.usermanager/org.nuxeo.ecm.platform.usermanager.UserService/Services/org.nuxeo.ecm.platform.usermanager.MultiTenantUserManager", "id": "org.nuxeo.ecm.platform.usermanager.MultiTenantUserManager", "overriden": false, "version": "2021.53.3" }, { "@type": "NXService", "componentId": "org.nuxeo.ecm.platform.usermanager.UserService", "hierarchyPath": "/grp:org.nuxeo.ecm.platform/org.nuxeo.ecm.platform.usermanager/org.nuxeo.ecm.platform.usermanager.UserService/Services/org.nuxeo.ecm.platform.usermanager.UserManager", "id": "org.nuxeo.ecm.platform.usermanager.UserManager", "overriden": false, "version": "2021.53.3" }, { "@type": "NXService", "componentId": "org.nuxeo.ecm.platform.usermanager.UserService", "hierarchyPath": "/grp:org.nuxeo.ecm.platform/org.nuxeo.ecm.platform.usermanager/org.nuxeo.ecm.platform.usermanager.UserService/Services/org.nuxeo.runtime.api.login.Authenticator", "id": "org.nuxeo.runtime.api.login.Authenticator", "overriden": false, "version": "2021.53.3" }, { "@type": "NXService", "componentId": "org.nuxeo.ecm.platform.usermanager.UserService", "hierarchyPath": "/grp:org.nuxeo.ecm.platform/org.nuxeo.ecm.platform.usermanager/org.nuxeo.ecm.platform.usermanager.UserService/Services/org.nuxeo.ecm.core.api.security.AdministratorGroupsProvider", "id": "org.nuxeo.ecm.core.api.security.AdministratorGroupsProvider", "overriden": false, "version": "2021.53.3" } ], "startOrder": 906, "version": "2021.53.3", "xmlFileContent": "\n\n \n \n somedirectory \n mail \n \n first \n last \n \n tabbed \n \n Anonymous \n User \n \n \n ******** \n My Custom \n Administrator \n administrators \n \n \n ******** \n My Custom \n Member \n members \n othergroup \n \n item1 \n item2 \n \n \n \n \n admin \n myAdministrators \n \n false\n \n sn \n ^[a-zA-Z0-9]{5,}$ \n \n somegroupdir \n members \n grouplabel \n subgroups \n parentgroup \n search_only \n \n grouplabel \n groupname \n \n \n members \n groupname \n \n \n \n If the element anonymousUser has the attribute remove=\"true\", then the\n anonymous user will be disabled. The anonymous user is searchable by\n default.\n \n If a virtual user has the attribute remove=\"true\", it is removed from the\n list of virtual users. Virtual users are searchable by default, but it is\n not implemented yet... so you should keep the attribute searchable=\"false\"\n to keep the same behaviour when it will be.\n \n Virtual users with the \"administrators\" group will have the same rights\n than the default administrator.\n \n New administrators groups can be added using the \"administratorsGroup\"\n tag. Several groups can be defined, adding as many tags as needed. The\n default group named \"administrators\" can be disabled by setting the\n \"disableDefaultAdministratorsGroup\" to \"true\" (defaults to false): only\n new defined administrators groups will then be taken into account. Note\n that disabling this default group should be done after setting up custom\n rights in the repository, as this group is usually defined as the group of\n users who have all permissions at the root of the repository.\n \n Anonymous and virtual users properties have to match the users directory\n schema fields to be taken into account.\n \n The userPasswordPattern format is specified by java.util.regex.Pattern.\n \n The values for users listingMode are: \"all\", \"tabbed\", \"search_only\".\n (These values are defined in\n org.nuxeo.ecm.webapp.security.UserManagerActionsBean.)\n \n The values for groups listingMode are: \"all\" and \"search_only\".\n \n \n fullClassName \n \n\n\n\n The contributed class must implement the org.nuxeo.ecm.platform.computedgroups.GroupComputer interface.\n\n To simplify the Computer group generation you can also contribute a simple group computer without java\n code contribution based on\n \n \n \n\n\n Here for each user, during the connection time, Nuxeo affect the group grade_xxx where xxx the value of\n the company metadata stored into the user profile. If the company metadata is empty or contains only spaces\n No group is affected to the user.\n\n For the second possibility (metadata given a list of documents), you just have to contribute:\n \n \n \n\n\n Here, we select documents created by the user. For each document found, we affect the group creator_xxx where xxx\n is the title of the document. But you can also try this:\n\n \n \n \n\n\n Here, xxx is replaced by the id of the document. XPath value is based on NXQL query and fetch selector. See the NXQL documentation\n to have more information.\n\n @author Thierry Delprat (td@nuxeo.com)\n @author Benjamin JALON (bjalon@nuxeo.com)\n \n",
"documentationHtml": "\nExtension point to contribute a new class to compute virtual groups.\n
\nThe contribution should be as the following example :\n
<groupComputer name="MyGroupComputerName">\n <computer>fullClassName</computer>\n </groupComputer>\n\nThe contributed class must implement the org.nuxeo.ecm.platform.computedgroups.GroupComputer interface.\n
\nTo simplify the Computer group generation you can also contribute a simple group computer without java\ncode contribution based on\n
\nFor the first case, you just have to contribute:\n
<userMetadataGroupComputer enabled="false" groupPattern="grade_%s"\n name="grade_cg" xpath="company"/>\n\nHere for each user, during the connection time, Nuxeo affect the group grade_xxx where xxx the value of\nthe company metadata stored into the user profile. If the company metadata is empty or contains only spaces\nNo group is affected to the user.\n
\nFor the second possibility (metadata given a list of documents), you just have to contribute:\n
<documentMetadataGroupComputer groupPattern="creator_%s"\n name="creator_cg" whereClause="dc:creator = '%s'" xpath="dc:title"/>\n\nHere, we select documents created by the user. For each document found, we affect the group creator_xxx where xxx\nis the title of the document. But you can also try this:\n
\n
<documentMetadataGroupComputer groupPattern="creator_%s"\n name="creator_cg" whereClause="dc:creator = '%s'" xpath="ecm:uuid"/>\n\nHere, xxx is replaced by the id of the document. XPath value is based on NXQL query and fetch selector. See the NXQL documentation\nto have more information.\n
", "hierarchyPath": "/grp:org.nuxeo.ecm.platform/org.nuxeo.ecm.platform.usermanager/org.nuxeo.ecm.platform.computedgroups.ComputedGroupsServiceImpl/ExtensionPoints/org.nuxeo.ecm.platform.computedgroups.ComputedGroupsServiceImpl--computer", "id": "org.nuxeo.ecm.platform.computedgroups.ComputedGroupsServiceImpl--computer", "label": "computer (org.nuxeo.ecm.platform.computedgroups.ComputedGroupsServiceImpl)", "name": "computer", "version": "2021.53.3" }, { "@type": "NXExtensionPoint", "componentId": "org.nuxeo.ecm.platform.computedgroups.ComputedGroupsServiceImpl", "descriptors": [ "org.nuxeo.ecm.platform.computedgroups.GroupComputerChainDescriptor" ], "documentation": "\n Extension point to set or update the chain of group computer.\n The GroupComputers will be called sequentially according the chain definition.\n\n The contribution should be of the form :\n\n \n \n companyGroupComputer \n myOtherGroupComputer \n \n \n\n\n\n By default, each contribution will completly overwrite the chain.\n If you just want to add a new computer to the existing chain, set the append attribute to true.\n\n \n \n \n myAdditionnalGroupComputer \n \n \n\n\n\n @author Thierry Delprat (td@nuxeo.com)\n \n",
"documentationHtml": "\nExtension point to set or update the chain of group computer.\nThe GroupComputers will be called sequentially according the chain definition.\n
\nThe contribution should be of the form :\n
<groupComputerChain>\n <computers>\n <computer>companyGroupComputer</computer>\n <computer>myOtherGroupComputer</computer>\n </computers>\n </groupComputerChain>\n\nBy default, each contribution will completly overwrite the chain.\nIf you just want to add a new computer to the existing chain, set the append attribute to true.\n
\n
<groupComputerChain append="true">\n <computers>\n <computer>myAdditionnalGroupComputer</computer>\n </computers>\n </groupComputerChain>\n\n \n fullClassName \n \n \n\n The contributed class must implement the org.nuxeo.ecm.platform.computedgroups.GroupComputer interface.\n\n To simplify the Computer group generation you can also contribute a simple group computer without java\n code contribution based on\n \n \n \n\n Here for each user, during the connection time, Nuxeo affect the group grade_xxx where xxx the value of\n the company metadata stored into the user profile. If the company metadata is empty or contains only spaces\n No group is affected to the user.\n\n For the second possibility (metadata given a list of documents), you just have to contribute:\n \n \n \n\n Here, we select documents created by the user. For each document found, we affect the group creator_xxx where xxx\n is the title of the document. But you can also try this:\n\n \n \n \n\n Here, xxx is replaced by the id of the document. XPath value is based on NXQL query and fetch selector. See the NXQL documentation\n to have more information.\n\n @author Thierry Delprat (td@nuxeo.com)\n @author Benjamin JALON (bjalon@nuxeo.com)\n \n \n \n companyGroupComputer \n myOtherGroupComputer \n \n \n \n\n By default, each contribution will completly overwrite the chain.\n If you just want to add a new computer to the existing chain, set the append attribute to true.\n\n \n \n \n myAdditionnalGroupComputer \n \n \n \n\n @author Thierry Delprat (td@nuxeo.com)\n \nAdapters for UserModel
", "extensionPoints": [], "extensions": [ { "@type": "NXContribution", "documentationHtml": "", "extensionPoint": "org.nuxeo.ecm.core.api.DocumentAdapterService--adapters", "hierarchyPath": "/grp:org.nuxeo.ecm.platform/org.nuxeo.ecm.platform.usermanager/org.nuxeo.ecm.platform.usermanager.adapter/Contributions/org.nuxeo.ecm.platform.usermanager.adapter--adapters", "id": "org.nuxeo.ecm.platform.usermanager.adapter--adapters", "registrationOrder": 21, "targetComponentName": { "rawName": "service:org.nuxeo.ecm.core.api.DocumentAdapterService", "name": "org.nuxeo.ecm.core.api.DocumentAdapterService", "type": "service" }, "version": "2021.53.3", "xml": "\nResolver for NuxeoPrincipal and NuxeoGroup document properties. Values for properties must be prefixed\nby 'user:' or 'group:'.\n
", "extensionPoints": [], "extensions": [ { "@type": "NXContribution", "documentationHtml": "", "extensionPoint": "org.nuxeo.ecm.core.schema.ObjectResolverService--resolvers", "hierarchyPath": "/grp:org.nuxeo.ecm.platform/org.nuxeo.ecm.platform.usermanager/org.nuxeo.ecm.platform.usermanager.resolver/Contributions/org.nuxeo.ecm.platform.usermanager.resolver--resolvers", "id": "org.nuxeo.ecm.platform.usermanager.resolver--resolvers", "registrationOrder": 2, "targetComponentName": { "rawName": "service:org.nuxeo.ecm.core.schema.ObjectResolverService", "name": "org.nuxeo.ecm.core.schema.ObjectResolverService", "type": "service" }, "version": "2021.53.3", "xml": "\nCore IO registered marshallers set.\n
", "extensionPoints": [], "extensions": [ { "@type": "NXContribution", "documentationHtml": "", "extensionPoint": "org.nuxeo.ecm.core.io.MarshallerRegistry--marshallers", "hierarchyPath": "/grp:org.nuxeo.ecm.platform/org.nuxeo.ecm.platform.usermanager/org.nuxeo.ecm.platform.usermanager.marshallers/Contributions/org.nuxeo.ecm.platform.usermanager.marshallers--marshallers", "id": "org.nuxeo.ecm.platform.usermanager.marshallers--marshallers", "registrationOrder": 21, "targetComponentName": { "rawName": "service:org.nuxeo.ecm.core.io.MarshallerRegistry", "name": "org.nuxeo.ecm.core.io.MarshallerRegistry", "type": "service" }, "version": "2021.53.3", "xml": "\nControls whether we check the validity of password when changing it.\n
\n@since 8.4\n
", "extensionPoint": "org.nuxeo.runtime.ConfigurationService--configuration", "hierarchyPath": "/grp:org.nuxeo.ecm.platform/org.nuxeo.ecm.platform.usermanager/org.nuxeo.ecm.platform.usermanager.properties/Contributions/org.nuxeo.ecm.platform.usermanager.properties--configuration", "id": "org.nuxeo.ecm.platform.usermanager.properties--configuration", "registrationOrder": 46, "targetComponentName": { "rawName": "service:org.nuxeo.runtime.ConfigurationService", "name": "org.nuxeo.runtime.ConfigurationService", "type": "service" }, "version": "2021.53.3", "xml": "\n\nControls whether the UserManager.searchUsers(pattern) and UserManager.searchGroups(pattern)\nAPIs interpret the pattern as a generic string with arbitrary characters\nthat will be matched exactly (depending on the directory substring match style)\n(non-compat mode), or as a LIKE pattern where % and _ are interpreted as LIKE escapes (compat mode).\n
\n@since 11.1\n
", "extensionPoint": "org.nuxeo.runtime.ConfigurationService--configuration", "hierarchyPath": "/grp:org.nuxeo.ecm.platform/org.nuxeo.ecm.platform.usermanager/org.nuxeo.ecm.platform.usermanager.properties/Contributions/org.nuxeo.ecm.platform.usermanager.properties--configuration1", "id": "org.nuxeo.ecm.platform.usermanager.properties--configuration1", "registrationOrder": 47, "targetComponentName": { "rawName": "service:org.nuxeo.runtime.ConfigurationService", "name": "org.nuxeo.runtime.ConfigurationService", "type": "service" }, "version": "2021.53.3", "xml": "